<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qtextformat.cpp -->
  <title>QTextFormat Class | Qt GUI 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qtgui-index.html">Qt GUI</a></td><td ><a href="qtgui-module.html">C++ Classes</a></td><td >QTextFormat</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtgui-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QTextFormat Class</h1>
<!-- $$$QTextFormat-brief -->
<p>The QTextFormat class provides formatting information for a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<!-- @@@QTextFormat -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QTextFormat&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += gui</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextframeformat.html">QTextFrameFormat</a>, and <a href="qtextlistformat.html">QTextListFormat</a></p>
</td></tr></table></div><ul>
<li><a href="qtextformat-members.html">List of all members, including inherited members</a></li>
</ul>
<p><b>Note:</b> All functions in this class are <a href="../qtdoc/threads-reentrancy.html">reentrant</a>.</p>
<a name="public-types"></a>
<h2 id="public-types">Public Types</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#FormatType-enum">FormatType</a></b> { InvalidFormat, BlockFormat, CharFormat, ListFormat, FrameFormat, UserFormat }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a></b> { NoObject, ImageObject, TableObject, TableCellObject, UserObject }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlag</a></b> { PageBreak_Auto, PageBreak_AlwaysBefore, PageBreak_AlwaysAfter }</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> flags </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlags</a></b></td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#Property-enum">Property</a></b> { ObjectIndex, CssFloat, LayoutDirection, OutlinePen, ForegroundBrush, &hellip;, UserProperty }</td></tr>
</table></div>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#QTextFormat-2">QTextFormat</a></b>(const QTextFormat &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#QTextFormat-1">QTextFormat</a></b>(int <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#QTextFormat">QTextFormat</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextFormat &amp;</td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#operator-eq">operator=</a></b>(const QTextFormat &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#dtor.QTextFormat">~QTextFormat</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBrush </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#background">background</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#boolProperty">boolProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBrush </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#brushProperty">brushProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#clearBackground">clearBackground</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#clearForeground">clearForeground</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#clearProperty">clearProperty</a></b>(int <i>propertyId</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QColor </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#colorProperty">colorProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> qreal </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#doubleProperty">doubleProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBrush </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#foreground">foreground</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#hasProperty">hasProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#intProperty">intProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isBlockFormat">isBlockFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isCharFormat">isCharFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isEmpty">isEmpty</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isFrameFormat">isFrameFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isImageFormat">isImageFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isListFormat">isListFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isTableCellFormat">isTableCellFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isTableFormat">isTableFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#isValid">isValid</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt::LayoutDirection </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#layoutDirection">layoutDirection</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextLength </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#lengthProperty">lengthProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVector&lt;QTextLength&gt; </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#merge">merge</a></b>(const QTextFormat &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#objectIndex">objectIndex</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#objectType">objectType</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QPen </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#penProperty">penProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QMap&lt;int, QVariant&gt; </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#properties">properties</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#property">property</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#propertyCount">propertyCount</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setBackground">setBackground</a></b>(const QBrush &amp;<i>brush</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setForeground">setForeground</a></b>(const QBrush &amp;<i>brush</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a></b>(Qt::LayoutDirection <i>direction</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setObjectIndex">setObjectIndex</a></b>(int <i>index</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setObjectType">setObjectType</a></b>(int <i>type</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setProperty">setProperty</a></b>(int <i>propertyId</i>, const QVariant &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#setProperty-1">setProperty</a></b>(int <i>propertyId</i>, const QVector&lt;QTextLength&gt; &amp;<i>value</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QString </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#stringProperty">stringProperty</a></b>(int <i>propertyId</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#swap">swap</a></b>(QTextFormat &amp;<i>other</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextBlockFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toBlockFormat">toBlockFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextCharFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toCharFormat">toCharFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextFrameFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toFrameFormat">toFrameFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextImageFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toImageFormat">toImageFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextListFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toListFormat">toListFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextTableCellFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toTableCellFormat">toTableCellFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QTextTableFormat </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#toTableFormat">toTableFormat</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#type">type</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QVariant </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#operator-QVariant">operator QVariant</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#operator-not-eq">operator!=</a></b>(const QTextFormat &amp;<i>other</i>) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qtextformat.html#operator-eq-eq">operator==</a></b>(const QTextFormat &amp;<i>other</i>) const</td></tr>
</table></div>
<a name="details"></a>
<!-- $$$QTextFormat-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>A QTextFormat is a generic class used for describing the format of parts of a <a href="qtextdocument.html">QTextDocument</a>. The derived classes <a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextlistformat.html">QTextListFormat</a>, and <a href="qtexttableformat.html">QTextTableFormat</a> are usually more useful, and describe the formatting that is applied to specific parts of the document.</p>
<p>A format has a <code>FormatType</code> which specifies the kinds of text item it can format; e.g&#x2e; a block of text, a list, a table, etc. A format also has various properties (some specific to particular format types), as described by the Property enum. Every property has a corresponding Property.</p>
<p>The format type is given by <a href="qtextformat.html#type">type</a>(), and the format can be tested with <a href="qtextformat.html#isCharFormat">isCharFormat</a>(), <a href="qtextformat.html#isBlockFormat">isBlockFormat</a>(), <a href="qtextformat.html#isListFormat">isListFormat</a>(), <a href="qtextformat.html#isTableFormat">isTableFormat</a>(), <a href="qtextformat.html#isFrameFormat">isFrameFormat</a>(), and <a href="qtextformat.html#isImageFormat">isImageFormat</a>(). If the type is determined, it can be retrieved with <a href="qtextformat.html#toCharFormat">toCharFormat</a>(), <a href="qtextformat.html#toBlockFormat">toBlockFormat</a>(), <a href="qtextformat.html#toListFormat">toListFormat</a>(), <a href="qtextformat.html#toTableFormat">toTableFormat</a>(), <a href="qtextformat.html#toFrameFormat">toFrameFormat</a>(), and <a href="qtextformat.html#toImageFormat">toImageFormat</a>().</p>
<p>A format's properties can be set with the <a href="qtextformat.html#setProperty">setProperty</a>() functions, and retrieved with <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), and <a href="qtextformat.html#stringProperty">stringProperty</a>() as appropriate. All the property IDs used in the format can be retrieved with allPropertyIds(). One format can be merged into another using <a href="qtextformat.html#merge">merge</a>().</p>
<p>A format's object index can be set with <a href="qtextformat.html#setObjectIndex">setObjectIndex</a>(), and retrieved with <a href="qtextformat.html#objectIndex">objectIndex</a>(). These methods can be used to associate the format with a <a href="qtextobject.html">QTextObject</a>. It is used to represent lists, frames, and tables inside the document.</p>
</div>
<p><b>See also </b><a href="richtext.html">Rich Text Processing</a>.</p>
<!-- @@@QTextFormat -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$FormatType$$$InvalidFormat$$$BlockFormat$$$CharFormat$$$ListFormat$$$TableFormat$$$FrameFormat$$$UserFormat -->
<h3 class="fn" id="FormatType-enum"><a name="FormatType-enum"></a>enum QTextFormat::<span class="name">FormatType</span></h3>
<p>This enum describes the text item a <a href="qtextformat.html">QTextFormat</a> object is formatting.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::InvalidFormat</code></td><td class="topAlign tblval"><code>-1</code></td><td class="topAlign">An invalid format as created by the default constructor</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockFormat</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The object formats a text block</td></tr>
<tr><td class="topAlign"><code>QTextFormat::CharFormat</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">The object formats a single character</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ListFormat</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">The object formats a list</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameFormat</code></td><td class="topAlign tblval"><code>5</code></td><td class="topAlign">The object formats a frame</td></tr>
<tr><td class="topAlign"><code>QTextFormat::UserFormat</code></td><td class="topAlign tblval"><code>100</code></td><td class="topAlign">&nbsp;</td></tr>
</table></div>
<p><b>See also </b><a href="qtextcharformat.html">QTextCharFormat</a>, <a href="qtextblockformat.html">QTextBlockFormat</a>, <a href="qtextlistformat.html">QTextListFormat</a>, <a href="qtexttableformat.html">QTextTableFormat</a>, and <a href="qtextformat.html#type">type</a>().</p>
<!-- @@@FormatType -->
<!-- $$$ObjectTypes$$$NoObject$$$ImageObject$$$TableObject$$$TableCellObject$$$UserObject -->
<h3 class="fn" id="ObjectTypes-enum"><a name="ObjectTypes-enum"></a>enum QTextFormat::<span class="name">ObjectTypes</span></h3>
<p>This enum describes what kind of <a href="qtextobject.html">QTextObject</a> this format is associated with.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::NoObject</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageObject</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableObject</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellObject</code></td><td class="topAlign tblval"><code>3</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::UserObject</code></td><td class="topAlign tblval"><code>0x1000</code></td><td class="topAlign">The first object that can be used for application-specific purposes.</td></tr>
</table></div>
<p><b>See also </b><a href="qtextobject.html">QTextObject</a>, <a href="qtexttable.html">QTextTable</a>, and <a href="qtextobject.html#format">QTextObject::format</a>().</p>
<!-- @@@ObjectTypes -->
<!-- $$$PageBreakFlag$$$PageBreak_Auto$$$PageBreak_AlwaysBefore$$$PageBreak_AlwaysAfter -->
<h3 class="flags" id="PageBreakFlag-enum"><a name="PageBreakFlag-enum"></a>enum QTextFormat::<span class="name">PageBreakFlag</span><br/>flags QTextFormat::<span class="name">PageBreakFlags</span></h3>
<p>This enum describes how page breaking is performed when printing. It maps to the corresponding css properties.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::PageBreak_Auto</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The page break is determined automatically depending on the available space on the current page</td></tr>
<tr><td class="topAlign"><code>QTextFormat::PageBreak_AlwaysBefore</code></td><td class="topAlign tblval"><code>0x001</code></td><td class="topAlign">The page is always broken before the paragraph/table</td></tr>
<tr><td class="topAlign"><code>QTextFormat::PageBreak_AlwaysAfter</code></td><td class="topAlign tblval"><code>0x010</code></td><td class="topAlign">A new page is always started after the paragraph/table</td></tr>
</table></div>
<p>This enum was introduced or modified in Qt 4.2.</p>
<p>The PageBreakFlags type is a typedef for <a href="../qtcore/qflags.html">QFlags</a>&lt;PageBreakFlag&gt;. It stores an OR combination of PageBreakFlag values.</p>
<p><b>See also </b><a href="qtextblockformat.html#pageBreakPolicy">QTextBlockFormat::pageBreakPolicy</a>(), <a href="qtextframeformat.html#pageBreakPolicy">QTextFrameFormat::pageBreakPolicy</a>(), and <a href="qtextformat.html#Property-enum">PageBreakPolicy</a>.</p>
<!-- @@@PageBreakFlag -->
<!-- $$$Property$$$ObjectIndex$$$CssFloat$$$LayoutDirection$$$OutlinePen$$$BackgroundBrush$$$ForegroundBrush$$$BackgroundImageUrl$$$BlockAlignment$$$BlockTopMargin$$$BlockBottomMargin$$$BlockLeftMargin$$$BlockRightMargin$$$TextIndent$$$TabPositions$$$BlockIndent$$$LineHeight$$$LineHeightType$$$BlockNonBreakableLines$$$BlockTrailingHorizontalRulerWidth$$$HeadingLevel$$$BlockQuoteLevel$$$BlockCodeLanguage$$$BlockCodeFence$$$BlockMarker$$$FirstFontProperty$$$FontCapitalization$$$FontLetterSpacingType$$$FontLetterSpacing$$$FontWordSpacing$$$FontStretch$$$FontStyleHint$$$FontStyleStrategy$$$FontKerning$$$FontHintingPreference$$$FontFamilies$$$FontStyleName$$$FontFamily$$$FontPointSize$$$FontSizeAdjustment$$$FontSizeIncrement$$$FontWeight$$$FontItalic$$$FontUnderline$$$FontOverline$$$FontStrikeOut$$$FontFixedPitch$$$FontPixelSize$$$LastFontProperty$$$TextUnderlineColor$$$TextVerticalAlignment$$$TextOutline$$$TextUnderlineStyle$$$TextToolTip$$$IsAnchor$$$AnchorHref$$$AnchorName$$$ObjectType$$$ListStyle$$$ListIndent$$$ListNumberPrefix$$$ListNumberSuffix$$$FrameBorder$$$FrameMargin$$$FramePadding$$$FrameWidth$$$FrameHeight$$$FrameTopMargin$$$FrameBottomMargin$$$FrameLeftMargin$$$FrameRightMargin$$$FrameBorderBrush$$$FrameBorderStyle$$$TableColumns$$$TableColumnWidthConstraints$$$TableCellSpacing$$$TableCellPadding$$$TableHeaderRowCount$$$TableBorderCollapse$$$TableCellRowSpan$$$TableCellColumnSpan$$$TableCellTopPadding$$$TableCellBottomPadding$$$TableCellLeftPadding$$$TableCellRightPadding$$$TableCellTopBorder$$$TableCellBottomBorder$$$TableCellLeftBorder$$$TableCellRightBorder$$$TableCellTopBorderStyle$$$TableCellBottomBorderStyle$$$TableCellLeftBorderStyle$$$TableCellRightBorderStyle$$$TableCellTopBorderBrush$$$TableCellBottomBorderBrush$$$TableCellLeftBorderBrush$$$TableCellRightBorderBrush$$$ImageName$$$ImageTitle$$$ImageAltText$$$ImageWidth$$$ImageHeight$$$ImageQuality$$$FullWidthSelection$$$PageBreakPolicy$$$UserProperty -->
<h3 class="fn" id="Property-enum"><a name="Property-enum"></a>enum QTextFormat::<span class="name">Property</span></h3>
<p>This enum describes the different properties a format can have.</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::ObjectIndex</code></td><td class="topAlign tblval"><code>0x0</code></td><td class="topAlign">The index of the formatted object. See <a href="qtextformat.html#objectIndex">objectIndex</a>().</td></tr>
</table></div>
<p>Paragraph and character properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::CssFloat</code></td><td class="topAlign tblval"><code>0x0800</code></td><td class="topAlign">How a frame is located relative to the surrounding text</td></tr>
<tr><td class="topAlign"><code>QTextFormat::LayoutDirection</code></td><td class="topAlign tblval"><code>0x0801</code></td><td class="topAlign">The layout direction of the text in the document (<a href="../qtcore/qt.html#LayoutDirection-enum">Qt::LayoutDirection</a>).</td></tr>
<tr><td class="topAlign"><code>QTextFormat::OutlinePen</code></td><td class="topAlign tblval"><code>0x810</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ForegroundBrush</code></td><td class="topAlign tblval"><code>0x821</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BackgroundBrush</code></td><td class="topAlign tblval"><code>0x820</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BackgroundImageUrl</code></td><td class="topAlign tblval"><code>0x823</code></td><td class="topAlign">&nbsp;</td></tr>
</table></div>
<p>Paragraph properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockAlignment</code></td><td class="topAlign tblval"><code>0x1010</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockTopMargin</code></td><td class="topAlign tblval"><code>0x1030</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockBottomMargin</code></td><td class="topAlign tblval"><code>0x1031</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockLeftMargin</code></td><td class="topAlign tblval"><code>0x1032</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockRightMargin</code></td><td class="topAlign tblval"><code>0x1033</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextIndent</code></td><td class="topAlign tblval"><code>0x1034</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TabPositions</code></td><td class="topAlign tblval"><code>0x1035</code></td><td class="topAlign">Specifies the tab positions. The tab positions are structs of <a href="qtextoption-tab.html">QTextOption::Tab</a> which are stored in a <a href="../qtcore/qlist.html">QList</a> (internally, in a <a href="../qtcore/qlist.html">QList</a>&lt;<a href="../qtcore/qvariant.html">QVariant</a>&gt;).</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockIndent</code></td><td class="topAlign tblval"><code>0x1040</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::LineHeight</code></td><td class="topAlign tblval"><code>0x1048</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::LineHeightType</code></td><td class="topAlign tblval"><code>0x1049</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockNonBreakableLines</code></td><td class="topAlign tblval"><code>0x1050</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockTrailingHorizontalRulerWidth</code></td><td class="topAlign tblval"><code>0x1060</code></td><td class="topAlign">The width of a horizontal ruler element.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::HeadingLevel</code></td><td class="topAlign tblval"><code>0x1070</code></td><td class="topAlign">The level of a heading, for example 1 corresponds to an HTML H1 tag; otherwise 0. This enum value has been added in Qt 5.12.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockCodeFence</code></td><td class="topAlign tblval"><code>0x1091</code></td><td class="topAlign">The character that was used in the &quot;fences&quot; around a Markdown code block. If the code block was indented rather than fenced, the block should not have this property. This enum value has been added in Qt 5.14.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockQuoteLevel</code></td><td class="topAlign tblval"><code>0x1080</code></td><td class="topAlign">The depth of nested quoting on this block: 1 means the block is a top-level block quote. Blocks that are not block quotes should not have this property. This enum value has been added in Qt 5.14.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockCodeLanguage</code></td><td class="topAlign tblval"><code>0x1090</code></td><td class="topAlign">The programming language in a preformatted or code block. Blocks that do not contain code should not have this property. This enum value has been added in Qt 5.14.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::BlockMarker</code></td><td class="topAlign tblval"><code>0x10A0</code></td><td class="topAlign">The <a href="qtextblockformat.html#MarkerType-enum">type of adornment</a> to be shown alongside the block. This enum value has been added in Qt 5.14.</td></tr>
</table></div>
<p>Character properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::FontFamily</code></td><td class="topAlign tblval"><code>0x2000</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontFamilies</code></td><td class="topAlign tblval"><code>0x1FE7</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontStyleName</code></td><td class="topAlign tblval"><code>0x1FE8</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontPointSize</code></td><td class="topAlign tblval"><code>0x2001</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontPixelSize</code></td><td class="topAlign tblval"><code>0x2009</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontSizeAdjustment</code></td><td class="topAlign tblval"><code>0x2002</code></td><td class="topAlign">Specifies the change in size given to the fontsize already set using FontPointSize or FontPixelSize.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontFixedPitch</code></td><td class="topAlign tblval"><code>0x2008</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontWeight</code></td><td class="topAlign tblval"><code>0x2003</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontItalic</code></td><td class="topAlign tblval"><code>0x2004</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontUnderline</code></td><td class="topAlign tblval"><code>0x2005</code></td><td class="topAlign"><i>This property has been deprecated.</i> Use QTextFormat::TextUnderlineStyle instead.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontOverline</code></td><td class="topAlign tblval"><code>0x2006</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontStrikeOut</code></td><td class="topAlign tblval"><code>0x2007</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontCapitalization</code></td><td class="topAlign tblval"><code>FirstFontProperty</code></td><td class="topAlign">Specifies the capitalization type that is to be applied to the text.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontLetterSpacingType</code></td><td class="topAlign tblval"><code>0x2033</code></td><td class="topAlign">Specifies the meaning of the FontLetterSpacing property. The default is <a href="qfont.html#SpacingType-enum">QFont::PercentageSpacing</a>.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontLetterSpacing</code></td><td class="topAlign tblval"><code>0x1FE1</code></td><td class="topAlign">Changes the default spacing between individual letters in the font. The value is specified as a percentage or absolute value, depending on FontLetterSpacingType. The default value is 100%.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontWordSpacing</code></td><td class="topAlign tblval"><code>0x1FE2</code></td><td class="topAlign">Changes the default spacing between individual words. A positive value increases the word spacing by the corresponding pixels; a negative value decreases the spacing.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontStretch</code></td><td class="topAlign tblval"><code>0x2034</code></td><td class="topAlign">Corresponds to the <a href="qfont.html#Stretch-enum">QFont::Stretch</a> property</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontStyleHint</code></td><td class="topAlign tblval"><code>0x1FE3</code></td><td class="topAlign">Corresponds to the <a href="qfont.html#StyleHint-enum">QFont::StyleHint</a> property</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontStyleStrategy</code></td><td class="topAlign tblval"><code>0x1FE4</code></td><td class="topAlign">Corresponds to the <a href="qfont.html#StyleStrategy-enum">QFont::StyleStrategy</a> property</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontKerning</code></td><td class="topAlign tblval"><code>0x1FE5</code></td><td class="topAlign">Specifies whether the font has kerning turned on.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FontHintingPreference</code></td><td class="topAlign tblval"><code>0x1FE6</code></td><td class="topAlign">Controls the use of hinting according to values of the <a href="qfont.html#HintingPreference-enum">QFont::HintingPreference</a> enum.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextUnderlineColor</code></td><td class="topAlign tblval"><code>0x2010</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextVerticalAlignment</code></td><td class="topAlign tblval"><code>0x2021</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextOutline</code></td><td class="topAlign tblval"><code>0x2022</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextUnderlineStyle</code></td><td class="topAlign tblval"><code>0x2023</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TextToolTip</code></td><td class="topAlign tblval"><code>0x2024</code></td><td class="topAlign">Specifies the (optional) tool tip to be displayed for a fragment of text.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::IsAnchor</code></td><td class="topAlign tblval"><code>0x2030</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::AnchorHref</code></td><td class="topAlign tblval"><code>0x2031</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::AnchorName</code></td><td class="topAlign tblval"><code>0x2032</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ObjectType</code></td><td class="topAlign tblval"><code>0x2f00</code></td><td class="topAlign">&nbsp;</td></tr>
</table></div>
<p>List properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::ListStyle</code></td><td class="topAlign tblval"><code>0x3000</code></td><td class="topAlign">Specifies the style used for the items in a list, described by values of the <a href="qtextlistformat.html#Style-enum">QTextListFormat::Style</a> enum.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ListIndent</code></td><td class="topAlign tblval"><code>0x3001</code></td><td class="topAlign">Specifies the amount of indentation used for a list.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ListNumberPrefix</code></td><td class="topAlign tblval"><code>0x3002</code></td><td class="topAlign">Defines the text which is prepended to item numbers in numeric lists.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ListNumberSuffix</code></td><td class="topAlign tblval"><code>0x3003</code></td><td class="topAlign">Defines the text which is appended to item numbers in numeric lists.</td></tr>
</table></div>
<p>Table and frame properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameBorder</code></td><td class="topAlign tblval"><code>0x4000</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameBorderBrush</code></td><td class="topAlign tblval"><code>0x4009</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameBorderStyle</code></td><td class="topAlign tblval"><code>0x4010</code></td><td class="topAlign">See the <a href="qtextframeformat.html#BorderStyle-enum">BorderStyle</a> enum.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameBottomMargin</code></td><td class="topAlign tblval"><code>0x4006</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameHeight</code></td><td class="topAlign tblval"><code>0x4004</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameLeftMargin</code></td><td class="topAlign tblval"><code>0x4007</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameMargin</code></td><td class="topAlign tblval"><code>0x4001</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FramePadding</code></td><td class="topAlign tblval"><code>0x4002</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameRightMargin</code></td><td class="topAlign tblval"><code>0x4008</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameTopMargin</code></td><td class="topAlign tblval"><code>0x4005</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::FrameWidth</code></td><td class="topAlign tblval"><code>0x4003</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellSpacing</code></td><td class="topAlign tblval"><code>0x4102</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellPadding</code></td><td class="topAlign tblval"><code>0x4103</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableColumns</code></td><td class="topAlign tblval"><code>0x4100</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableColumnWidthConstraints</code></td><td class="topAlign tblval"><code>0x4101</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableHeaderRowCount</code></td><td class="topAlign tblval"><code>0x4104</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableBorderCollapse</code></td><td class="topAlign tblval"><code>0x4105</code></td><td class="topAlign">Specifies the <a href="qtexttableformat.html#borderCollapse">QTextTableFormat::borderCollapse</a> property.</td></tr>
</table></div>
<p>Table cell properties</p>
<div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellRowSpan</code></td><td class="topAlign tblval"><code>0x4810</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellColumnSpan</code></td><td class="topAlign tblval"><code>0x4811</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellLeftPadding</code></td><td class="topAlign tblval"><code>0x4814</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellRightPadding</code></td><td class="topAlign tblval"><code>0x4815</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellTopPadding</code></td><td class="topAlign tblval"><code>0x4812</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellBottomPadding</code></td><td class="topAlign tblval"><code>0x4813</code></td></tr>
</table></div>
<p>Table cell properties intended for use with <a href="qtexttableformat.html#borderCollapse">QTextTableFormat::borderCollapse</a> enabled</p>
<div class="table"><table class="valuelist"><tr><th class="tblConst">Constant</th><th class="tblVal">Value</th></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellTopBorder</code></td><td class="topAlign tblval"><code>0x4816</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellBottomBorder</code></td><td class="topAlign tblval"><code>0x4817</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellLeftBorder</code></td><td class="topAlign tblval"><code>0x4818</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellRightBorder</code></td><td class="topAlign tblval"><code>0x4819</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellTopBorderStyle</code></td><td class="topAlign tblval"><code>0x481a</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellBottomBorderStyle</code></td><td class="topAlign tblval"><code>0x481b</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellLeftBorderStyle</code></td><td class="topAlign tblval"><code>0x481c</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellRightBorderStyle</code></td><td class="topAlign tblval"><code>0x481d</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellTopBorderBrush</code></td><td class="topAlign tblval"><code>0x481e</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellBottomBorderBrush</code></td><td class="topAlign tblval"><code>0x481f</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellLeftBorderBrush</code></td><td class="topAlign tblval"><code>0x4820</code></td></tr>
<tr><td class="topAlign"><code>QTextFormat::TableCellRightBorderBrush</code></td><td class="topAlign tblval"><code>0x4821</code></td></tr>
</table></div>
<p>Image properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageName</code></td><td class="topAlign tblval"><code>0x5000</code></td><td class="topAlign">The filename or source of the image.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageTitle</code></td><td class="topAlign tblval"><code>0x5001</code></td><td class="topAlign">The title attribute of an HTML image tag, or the quoted string that comes after the URL in a Markdown image link. This enum value has been added in Qt 5.14.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageAltText</code></td><td class="topAlign tblval"><code>0x5002</code></td><td class="topAlign">The alt attribute of an HTML image tag, or the image description in a Markdown image link. This enum value has been added in Qt 5.14.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageWidth</code></td><td class="topAlign tblval"><code>0x5010</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageHeight</code></td><td class="topAlign tblval"><code>0x5011</code></td><td class="topAlign">&nbsp;</td></tr>
<tr><td class="topAlign"><code>QTextFormat::ImageQuality</code></td><td class="topAlign tblval"><code>0x5014</code></td><td class="topAlign">&nbsp;</td></tr>
</table></div>
<p>Selection properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="even"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::FullWidthSelection</code></td><td class="topAlign tblval"><code>0x06000</code></td><td class="topAlign">When set on the characterFormat of a selection, the whole width of the text will be shown selected.</td></tr>
</table></div>
<p>Page break properties</p>
<div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><code>QTextFormat::PageBreakPolicy</code></td><td class="topAlign tblval"><code>0x7000</code></td><td class="topAlign">Specifies how pages are broken. See the <a href="qtextformat.html#PageBreakFlag-enum">PageBreakFlag</a> enum.</td></tr>
<tr><td class="topAlign"><code>QTextFormat::UserProperty</code></td><td class="topAlign tblval"><code>0x100000</code></td><td class="topAlign">&nbsp;</td></tr>
</table></div>
<p><b>See also </b><a href="qtextformat.html#property">property</a>() and <a href="qtextformat.html#setProperty">setProperty</a>().</p>
<!-- @@@Property -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QTextFormat$$$QTextFormatconstQTextFormat& -->
<h3 class="fn" id="QTextFormat-2"><a name="QTextFormat-2"></a>QTextFormat::<span class="name">QTextFormat</span>(const <span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>)</h3>
<p>Creates a new text format with the same attributes as the <i>other</i> text format.</p>
<!-- @@@QTextFormat -->
<!-- $$$QTextFormat$$$QTextFormatint -->
<h3 class="fn" id="QTextFormat-1"><a name="QTextFormat-1"></a>QTextFormat::<span class="name">QTextFormat</span>(<span class="type">int</span> <i>type</i>)</h3>
<p>Creates a new text format of the given <i>type</i>.</p>
<p><b>See also </b><a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<!-- @@@QTextFormat -->
<!-- $$$QTextFormat[overload1]$$$QTextFormat -->
<h3 class="fn" id="QTextFormat"><a name="QTextFormat"></a>QTextFormat::<span class="name">QTextFormat</span>()</h3>
<p>Creates a new text format with an <code>InvalidFormat</code>.</p>
<p><b>See also </b><a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<!-- @@@QTextFormat -->
<!-- $$$operator=[overload1]$$$operator=constQTextFormat& -->
<h3 class="fn" id="operator-eq"><a name="operator-eq"></a><span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;QTextFormat::<span class="name">operator=</span>(const <span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>)</h3>
<p>Assigns the <i>other</i> text format to this text format, and returns a reference to this text format.</p>
<!-- @@@operator= -->
<!-- $$$~QTextFormat[overload1]$$$~QTextFormat -->
<h3 class="fn" id="dtor.QTextFormat"><a name="dtor.QTextFormat"></a>QTextFormat::<span class="name">~QTextFormat</span>()</h3>
<p>Destroys this text format.</p>
<!-- @@@~QTextFormat -->
<!-- $$$background[overload1]$$$background -->
<h3 class="fn" id="background"><a name="background"></a><span class="type"><a href="qbrush.html">QBrush</a></span> QTextFormat::<span class="name">background</span>() const</h3>
<p>Returns the brush used to paint the document's background.</p>
<p><b>See also </b><a href="qtextformat.html#setBackground">setBackground</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#foreground">foreground</a>().</p>
<!-- @@@background -->
<!-- $$$boolProperty[overload1]$$$boolPropertyint -->
<h3 class="fn" id="boolProperty"><a name="boolProperty"></a><span class="type">bool</span> QTextFormat::<span class="name">boolProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of QTextFormat::Bool type, false is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@boolProperty -->
<!-- $$$brushProperty[overload1]$$$brushPropertyint -->
<h3 class="fn" id="brushProperty"><a name="brushProperty"></a><span class="type"><a href="qbrush.html">QBrush</a></span> QTextFormat::<span class="name">brushProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of QVariant::Brush type, <a href="../qtcore/qt.html#BrushStyle-enum">Qt::NoBrush</a> is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@brushProperty -->
<!-- $$$clearBackground[overload1]$$$clearBackground -->
<h3 class="fn" id="clearBackground"><a name="clearBackground"></a><span class="type">void</span> QTextFormat::<span class="name">clearBackground</span>()</h3>
<p>Clears the brush used to paint the document's background. The default brush will be used.</p>
<p><b>See also </b><a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#setBackground">setBackground</a>(), and <a href="qtextformat.html#clearForeground">clearForeground</a>().</p>
<!-- @@@clearBackground -->
<!-- $$$clearForeground[overload1]$$$clearForeground -->
<h3 class="fn" id="clearForeground"><a name="clearForeground"></a><span class="type">void</span> QTextFormat::<span class="name">clearForeground</span>()</h3>
<p>Clears the brush used to paint the document's foreground. The default brush will be used.</p>
<p><b>See also </b><a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#setForeground">setForeground</a>(), and <a href="qtextformat.html#clearBackground">clearBackground</a>().</p>
<!-- @@@clearForeground -->
<!-- $$$clearProperty[overload1]$$$clearPropertyint -->
<h3 class="fn" id="clearProperty"><a name="clearProperty"></a><span class="type">void</span> QTextFormat::<span class="name">clearProperty</span>(<span class="type">int</span> <i>propertyId</i>)</h3>
<p>Clears the value of the property given by <i>propertyId</i></p>
<p><b>See also </b><a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@clearProperty -->
<!-- $$$colorProperty[overload1]$$$colorPropertyint -->
<h3 class="fn" id="colorProperty"><a name="colorProperty"></a><span class="type"><a href="qcolor.html">QColor</a></span> QTextFormat::<span class="name">colorProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of QVariant::Color type, an invalid color is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@colorProperty -->
<!-- $$$doubleProperty[overload1]$$$doublePropertyint -->
<h3 class="fn" id="doubleProperty"><a name="doubleProperty"></a><span class="type"><a href="../qtcore/qtglobal.html#qreal-typedef">qreal</a></span> QTextFormat::<span class="name">doubleProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property isn't of QVariant::Double or <a href="../qtcore/qmetatype.html#Type-enum">QMetaType::Float</a> type, 0 is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@doubleProperty -->
<!-- $$$foreground[overload1]$$$foreground -->
<h3 class="fn" id="foreground"><a name="foreground"></a><span class="type"><a href="qbrush.html">QBrush</a></span> QTextFormat::<span class="name">foreground</span>() const</h3>
<p>Returns the brush used to render foreground details, such as text, frame outlines, and table borders.</p>
<p><b>See also </b><a href="qtextformat.html#setForeground">setForeground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#background">background</a>().</p>
<!-- @@@foreground -->
<!-- $$$hasProperty[overload1]$$$hasPropertyint -->
<h3 class="fn" id="hasProperty"><a name="hasProperty"></a><span class="type">bool</span> QTextFormat::<span class="name">hasProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns <code>true</code> if the text format has a property with the given <i>propertyId</i>; otherwise returns <code>false</code>.</p>
<p><b>See also </b><a href="qtextformat.html#properties">properties</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@hasProperty -->
<!-- $$$intProperty[overload1]$$$intPropertyint -->
<h3 class="fn" id="intProperty"><a name="intProperty"></a><span class="type">int</span> QTextFormat::<span class="name">intProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property specified by <i>propertyId</i>. If the property is not of QTextFormat::Integer type, 0 is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@intProperty -->
<!-- $$$isBlockFormat[overload1]$$$isBlockFormat -->
<h3 class="fn" id="isBlockFormat"><a name="isBlockFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isBlockFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>BlockFormat</code>; otherwise returns <code>false</code>.</p>
<!-- @@@isBlockFormat -->
<!-- $$$isCharFormat[overload1]$$$isCharFormat -->
<h3 class="fn" id="isCharFormat"><a name="isCharFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isCharFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>CharFormat</code>; otherwise returns <code>false</code>.</p>
<!-- @@@isCharFormat -->
<!-- $$$isEmpty[overload1]$$$isEmpty -->
<h3 class="fn" id="isEmpty"><a name="isEmpty"></a><span class="type">bool</span> QTextFormat::<span class="name">isEmpty</span>() const</h3>
<p>Returns true if the format does not store any properties; false otherwise.</p>
<p>This function was introduced in Qt 5.3.</p>
<p><b>See also </b><a href="qtextformat.html#propertyCount">propertyCount</a>() and <a href="qtextformat.html#properties">properties</a>().</p>
<!-- @@@isEmpty -->
<!-- $$$isFrameFormat[overload1]$$$isFrameFormat -->
<h3 class="fn" id="isFrameFormat"><a name="isFrameFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isFrameFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>FrameFormat</code>; otherwise returns <code>false</code>.</p>
<!-- @@@isFrameFormat -->
<!-- $$$isImageFormat[overload1]$$$isImageFormat -->
<h3 class="fn" id="isImageFormat"><a name="isImageFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isImageFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is an image format; otherwise returns <code>false</code>.</p>
<!-- @@@isImageFormat -->
<!-- $$$isListFormat[overload1]$$$isListFormat -->
<h3 class="fn" id="isListFormat"><a name="isListFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isListFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>ListFormat</code>; otherwise returns <code>false</code>.</p>
<!-- @@@isListFormat -->
<!-- $$$isTableCellFormat[overload1]$$$isTableCellFormat -->
<h3 class="fn" id="isTableCellFormat"><a name="isTableCellFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isTableCellFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>TableCellFormat</code>; otherwise returns <code>false</code>.</p>
<p>This function was introduced in Qt 4.4.</p>
<!-- @@@isTableCellFormat -->
<!-- $$$isTableFormat[overload1]$$$isTableFormat -->
<h3 class="fn" id="isTableFormat"><a name="isTableFormat"></a><span class="type">bool</span> QTextFormat::<span class="name">isTableFormat</span>() const</h3>
<p>Returns <code>true</code> if this text format is a <code>TableFormat</code>; otherwise returns <code>false</code>.</p>
<!-- @@@isTableFormat -->
<!-- $$$isValid[overload1]$$$isValid -->
<h3 class="fn" id="isValid"><a name="isValid"></a><span class="type">bool</span> QTextFormat::<span class="name">isValid</span>() const</h3>
<p>Returns <code>true</code> if the format is valid (i.e&#x2e; is not <a href="qtextformat.html#FormatType-enum">InvalidFormat</a>); otherwise returns <code>false</code>.</p>
<!-- @@@isValid -->
<!-- $$$layoutDirection[overload1]$$$layoutDirection -->
<h3 class="fn" id="layoutDirection"><a name="layoutDirection"></a><span class="type"><a href="../qtcore/qt.html#LayoutDirection-enum">Qt::LayoutDirection</a></span> QTextFormat::<span class="name">layoutDirection</span>() const</h3>
<p>Returns the document's layout direction.</p>
<p><b>See also </b><a href="qtextformat.html#setLayoutDirection">setLayoutDirection</a>().</p>
<!-- @@@layoutDirection -->
<!-- $$$lengthProperty[overload1]$$$lengthPropertyint -->
<h3 class="fn" id="lengthProperty"><a name="lengthProperty"></a><span class="type"><a href="qtextlength.html">QTextLength</a></span> QTextFormat::<span class="name">lengthProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@lengthProperty -->
<!-- $$$lengthVectorProperty[overload1]$$$lengthVectorPropertyint -->
<h3 class="fn" id="lengthVectorProperty"><a name="lengthVectorProperty"></a><span class="type"><a href="../qtcore/qvector.html">QVector</a></span>&lt;<span class="type"><a href="qtextlength.html">QTextLength</a></span>&gt; QTextFormat::<span class="name">lengthVectorProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>. If the property isn't of QTextFormat::LengthVector type, an empty length vector is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@lengthVectorProperty -->
<!-- $$$merge[overload1]$$$mergeconstQTextFormat& -->
<h3 class="fn" id="merge"><a name="merge"></a><span class="type">void</span> QTextFormat::<span class="name">merge</span>(const <span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>)</h3>
<p>Merges the <i>other</i> format with this format; where there are conflicts the <i>other</i> format takes precedence.</p>
<!-- @@@merge -->
<!-- $$$objectIndex[overload1]$$$objectIndex -->
<h3 class="fn" id="objectIndex"><a name="objectIndex"></a><span class="type">int</span> QTextFormat::<span class="name">objectIndex</span>() const</h3>
<p>Returns the index of the format object, or -1 if the format object is invalid.</p>
<p><b>See also </b><a href="qtextformat.html#setObjectIndex">setObjectIndex</a>().</p>
<!-- @@@objectIndex -->
<!-- $$$objectType[overload1]$$$objectType -->
<h3 class="fn" id="objectType"><a name="objectType"></a><span class="type">int</span> QTextFormat::<span class="name">objectType</span>() const</h3>
<p>Returns the text format's object type.</p>
<p><b>See also </b><a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a> and <a href="qtextformat.html#setObjectType">setObjectType</a>().</p>
<!-- @@@objectType -->
<!-- $$$penProperty[overload1]$$$penPropertyint -->
<h3 class="fn" id="penProperty"><a name="penProperty"></a><span class="type"><a href="qpen.html">QPen</a></span> QTextFormat::<span class="name">penProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of QVariant::Pen type, <a href="../qtcore/qt.html#PenStyle-enum">Qt::NoPen</a> is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#stringProperty">stringProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@penProperty -->
<!-- $$$properties[overload1]$$$properties -->
<h3 class="fn" id="properties"><a name="properties"></a><span class="type"><a href="../qtcore/qmap.html">QMap</a></span>&lt;<span class="type">int</span>, <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span>&gt; QTextFormat::<span class="name">properties</span>() const</h3>
<p>Returns a map with all properties of this text format.</p>
<!-- @@@properties -->
<!-- $$$property[overload1]$$$propertyint -->
<h3 class="fn" id="property"><a name="property"></a><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> QTextFormat::<span class="name">property</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the property specified by the given <i>propertyId</i>.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@property -->
<!-- $$$propertyCount[overload1]$$$propertyCount -->
<h3 class="fn" id="propertyCount"><a name="propertyCount"></a><span class="type">int</span> QTextFormat::<span class="name">propertyCount</span>() const</h3>
<p>Returns the number of properties stored in the format.</p>
<p>This function was introduced in Qt 4.3.</p>
<!-- @@@propertyCount -->
<!-- $$$setBackground[overload1]$$$setBackgroundconstQBrush& -->
<h3 class="fn" id="setBackground"><a name="setBackground"></a><span class="type">void</span> QTextFormat::<span class="name">setBackground</span>(const <span class="type"><a href="qbrush.html">QBrush</a></span> &amp;<i>brush</i>)</h3>
<p>Sets the brush use to paint the document's background to the <i>brush</i> specified.</p>
<p><b>See also </b><a href="qtextformat.html#background">background</a>(), <a href="qtextformat.html#clearBackground">clearBackground</a>(), and <a href="qtextformat.html#setForeground">setForeground</a>().</p>
<!-- @@@setBackground -->
<!-- $$$setForeground[overload1]$$$setForegroundconstQBrush& -->
<h3 class="fn" id="setForeground"><a name="setForeground"></a><span class="type">void</span> QTextFormat::<span class="name">setForeground</span>(const <span class="type"><a href="qbrush.html">QBrush</a></span> &amp;<i>brush</i>)</h3>
<p>Sets the foreground brush to the specified <i>brush</i>. The foreground brush is mostly used to render text.</p>
<p><b>See also </b><a href="qtextformat.html#foreground">foreground</a>(), <a href="qtextformat.html#clearForeground">clearForeground</a>(), and <a href="qtextformat.html#setBackground">setBackground</a>().</p>
<!-- @@@setForeground -->
<!-- $$$setLayoutDirection[overload1]$$$setLayoutDirectionQt::LayoutDirection -->
<h3 class="fn" id="setLayoutDirection"><a name="setLayoutDirection"></a><span class="type">void</span> QTextFormat::<span class="name">setLayoutDirection</span>(<span class="type"><a href="../qtcore/qt.html#LayoutDirection-enum">Qt::LayoutDirection</a></span> <i>direction</i>)</h3>
<p>Sets the document's layout direction to the specified <i>direction</i>.</p>
<p><b>See also </b><a href="qtextformat.html#layoutDirection">layoutDirection</a>().</p>
<!-- @@@setLayoutDirection -->
<!-- $$$setObjectIndex[overload1]$$$setObjectIndexint -->
<h3 class="fn" id="setObjectIndex"><a name="setObjectIndex"></a><span class="type">void</span> QTextFormat::<span class="name">setObjectIndex</span>(<span class="type">int</span> <i>index</i>)</h3>
<p>Sets the format object's object <i>index</i>.</p>
<p><b>See also </b><a href="qtextformat.html#objectIndex">objectIndex</a>().</p>
<!-- @@@setObjectIndex -->
<!-- $$$setObjectType[overload1]$$$setObjectTypeint -->
<h3 class="fn" id="setObjectType"><a name="setObjectType"></a><span class="type">void</span> QTextFormat::<span class="name">setObjectType</span>(<span class="type">int</span> <i>type</i>)</h3>
<p>Sets the text format's object type to <i>type</i>.</p>
<p><b>See also </b><a href="qtextformat.html#ObjectTypes-enum">ObjectTypes</a> and <a href="qtextformat.html#objectType">objectType</a>().</p>
<!-- @@@setObjectType -->
<!-- $$$setProperty[overload1]$$$setPropertyintconstQVariant& -->
<h3 class="fn" id="setProperty"><a name="setProperty"></a><span class="type">void</span> QTextFormat::<span class="name">setProperty</span>(<span class="type">int</span> <i>propertyId</i>, const <span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> &amp;<i>value</i>)</h3>
<p>Sets the property specified by the <i>propertyId</i> to the given <i>value</i>.</p>
<p><b>See also </b><a href="qtextformat.html#property">property</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@setProperty -->
<!-- $$$setProperty$$$setPropertyintconstQVector<QTextLength>& -->
<h3 class="fn" id="setProperty-1"><a name="setProperty-1"></a><span class="type">void</span> QTextFormat::<span class="name">setProperty</span>(<span class="type">int</span> <i>propertyId</i>, const <span class="type"><a href="../qtcore/qvector.html">QVector</a></span>&lt;<span class="type"><a href="qtextlength.html">QTextLength</a></span>&gt; &amp;<i>value</i>)</h3>
<p>Sets the value of the property given by <i>propertyId</i> to <i>value</i>.</p>
<p><b>See also </b><a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>() and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@setProperty -->
<!-- $$$stringProperty[overload1]$$$stringPropertyint -->
<h3 class="fn" id="stringProperty"><a name="stringProperty"></a><span class="type"><a href="../qtcore/qstring.html">QString</a></span> QTextFormat::<span class="name">stringProperty</span>(<span class="type">int</span> <i>propertyId</i>) const</h3>
<p>Returns the value of the property given by <i>propertyId</i>; if the property isn't of QVariant::String type, an empty string is returned instead.</p>
<p><b>See also </b><a href="qtextformat.html#setProperty">setProperty</a>(), <a href="qtextformat.html#boolProperty">boolProperty</a>(), <a href="qtextformat.html#intProperty">intProperty</a>(), <a href="qtextformat.html#doubleProperty">doubleProperty</a>(), <a href="qtextformat.html#colorProperty">colorProperty</a>(), <a href="qtextformat.html#lengthProperty">lengthProperty</a>(), <a href="qtextformat.html#lengthVectorProperty">lengthVectorProperty</a>(), and <a href="qtextformat.html#Property-enum">Property</a>.</p>
<!-- @@@stringProperty -->
<!-- $$$swap[overload1]$$$swapQTextFormat& -->
<h3 class="fn" id="swap"><a name="swap"></a><span class="type">void</span> QTextFormat::<span class="name">swap</span>(<span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>)</h3>
<p>Swaps this text format with <i>other</i>. This function is very fast and never fails.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@swap -->
<!-- $$$toBlockFormat[overload1]$$$toBlockFormat -->
<h3 class="fn" id="toBlockFormat"><a name="toBlockFormat"></a><span class="type"><a href="qtextblockformat.html">QTextBlockFormat</a></span> QTextFormat::<span class="name">toBlockFormat</span>() const</h3>
<p>Returns this format as a block format.</p>
<!-- @@@toBlockFormat -->
<!-- $$$toCharFormat[overload1]$$$toCharFormat -->
<h3 class="fn" id="toCharFormat"><a name="toCharFormat"></a><span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> QTextFormat::<span class="name">toCharFormat</span>() const</h3>
<p>Returns this format as a character format.</p>
<!-- @@@toCharFormat -->
<!-- $$$toFrameFormat[overload1]$$$toFrameFormat -->
<h3 class="fn" id="toFrameFormat"><a name="toFrameFormat"></a><span class="type"><a href="qtextframeformat.html">QTextFrameFormat</a></span> QTextFormat::<span class="name">toFrameFormat</span>() const</h3>
<p>Returns this format as a frame format.</p>
<!-- @@@toFrameFormat -->
<!-- $$$toImageFormat[overload1]$$$toImageFormat -->
<h3 class="fn" id="toImageFormat"><a name="toImageFormat"></a><span class="type"><a href="qtextimageformat.html">QTextImageFormat</a></span> QTextFormat::<span class="name">toImageFormat</span>() const</h3>
<p>Returns this format as an image format.</p>
<!-- @@@toImageFormat -->
<!-- $$$toListFormat[overload1]$$$toListFormat -->
<h3 class="fn" id="toListFormat"><a name="toListFormat"></a><span class="type"><a href="qtextlistformat.html">QTextListFormat</a></span> QTextFormat::<span class="name">toListFormat</span>() const</h3>
<p>Returns this format as a list format.</p>
<!-- @@@toListFormat -->
<!-- $$$toTableCellFormat[overload1]$$$toTableCellFormat -->
<h3 class="fn" id="toTableCellFormat"><a name="toTableCellFormat"></a><span class="type"><a href="qtexttablecellformat.html">QTextTableCellFormat</a></span> QTextFormat::<span class="name">toTableCellFormat</span>() const</h3>
<p>Returns this format as a table cell format.</p>
<p>This function was introduced in Qt 4.4.</p>
<!-- @@@toTableCellFormat -->
<!-- $$$toTableFormat[overload1]$$$toTableFormat -->
<h3 class="fn" id="toTableFormat"><a name="toTableFormat"></a><span class="type"><a href="qtexttableformat.html">QTextTableFormat</a></span> QTextFormat::<span class="name">toTableFormat</span>() const</h3>
<p>Returns this format as a table format.</p>
<!-- @@@toTableFormat -->
<!-- $$$type[overload1]$$$type -->
<h3 class="fn" id="type"><a name="type"></a><span class="type">int</span> QTextFormat::<span class="name">type</span>() const</h3>
<p>Returns the type of this format.</p>
<p><b>See also </b><a href="qtextformat.html#FormatType-enum">FormatType</a>.</p>
<!-- @@@type -->
<!-- $$$operator QVariant[overload1]$$$operator QVariant -->
<h3 class="fn" id="operator-QVariant"><a name="operator-QVariant"></a><span class="type"><a href="../qtcore/qvariant.html">QVariant</a></span> QTextFormat::<span class="name">operator QVariant</span>() const</h3>
<p>Returns the text format as a <a href="../qtcore/qvariant.html">QVariant</a></p>
<!-- @@@operator QVariant -->
<!-- $$$operator!=[overload1]$$$operator!=constQTextFormat& -->
<h3 class="fn" id="operator-not-eq"><a name="operator-not-eq"></a><span class="type">bool</span> QTextFormat::<span class="name">operator!=</span>(const <span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>) const</h3>
<p>Returns <code>true</code> if this text format is different from the <i>other</i> text format.</p>
<!-- @@@operator!= -->
<!-- $$$operator==[overload1]$$$operator==constQTextFormat& -->
<h3 class="fn" id="operator-eq-eq"><a name="operator-eq-eq"></a><span class="type">bool</span> QTextFormat::<span class="name">operator==</span>(const <span class="type"><a href="qtextformat.html#QTextFormat">QTextFormat</a></span> &amp;<i>other</i>) const</h3>
<p>Returns <code>true</code> if this text format is the same as the <i>other</i> text format.</p>
<!-- @@@operator== -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
